home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / dgegv.z / dgegv
Text File  |  1996-03-14  |  10KB  |  265 lines
  1.  
  2.  
  3.  
  4. DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DGEGV - compute for a pair of n-by-n real nonsymmetric matrices A and B,
  10.      the generalized eigenvalues (alphar +/- alphai*i, beta), and optionally,
  11.      the left and/or right generalized eigenvectors (VL and VR)
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE DGEGV( JOBVL, JOBVR, N, A, LDA, B, LDB, ALPHAR, ALPHAI, BETA,
  15.                        VL, LDVL, VR, LDVR, WORK, LWORK, INFO )
  16.  
  17.          CHARACTER     JOBVL, JOBVR
  18.  
  19.          INTEGER       INFO, LDA, LDB, LDVL, LDVR, LWORK, N
  20.  
  21.          DOUBLE        PRECISION A( LDA, * ), ALPHAI( * ), ALPHAR( * ), B(
  22.                        LDB, * ), BETA( * ), VL( LDVL, * ), VR( LDVR, * ),
  23.                        WORK( * )
  24.  
  25. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  26.      DGEGV computes for a pair of n-by-n real nonsymmetric matrices A and B,
  27.      the generalized eigenvalues (alphar +/- alphai*i, beta), and optionally,
  28.      the left and/or right generalized eigenvectors (VL and VR).
  29.  
  30.      A generalized eigenvalue for a pair of matrices (A,B) is, roughly
  31.      speaking, a scalar w or a ratio  alpha/beta = w, such that  A - w*B is
  32.      singular.  It is usually represented as the pair (alpha,beta), as there
  33.      is a reasonable interpretation for beta=0, and even for both being zero.
  34.      A good beginning reference is the book, "Matrix Computations", by G.
  35.      Golub & C. van Loan (Johns Hopkins U. Press)
  36.  
  37.      A right generalized eigenvector corresponding to a generalized eigenvalue
  38.      w  for a pair of matrices (A,B) is a vector  r  such that  (A - w B) r =
  39.      0 .  A left generalized eigenvector is a vector l such that l**H * (A - w
  40.      B) = 0, where l**H is the
  41.      conjugate-transpose of l.
  42.  
  43.      Note: this routine performs "full balancing" on A and B -- see "Further
  44.      Details", below.
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      JOBVL   (input) CHARACTER*1
  48.              = 'N':  do not compute the left generalized eigenvectors;
  49.              = 'V':  compute the left generalized eigenvectors.
  50.  
  51.      JOBVR   (input) CHARACTER*1
  52.              = 'N':  do not compute the right generalized eigenvectors;
  53.              = 'V':  compute the right generalized eigenvectors.
  54.  
  55.      N       (input) INTEGER
  56.              The order of the matrices A, B, VL, and VR.  N >= 0.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      A       (input/output) DOUBLE PRECISION array, dimension (LDA, N)
  75.              On entry, the first of the pair of matrices whose generalized
  76.              eigenvalues and (optionally) generalized eigenvectors are to be
  77.              computed.  On exit, the contents will have been destroyed.  (For
  78.              a description of the contents of A on exit, see "Further
  79.              Details", below.)
  80.  
  81.      LDA     (input) INTEGER
  82.              The leading dimension of A.  LDA >= max(1,N).
  83.  
  84.      B       (input/output) DOUBLE PRECISION array, dimension (LDB, N)
  85.              On entry, the second of the pair of matrices whose generalized
  86.              eigenvalues and (optionally) generalized eigenvectors are to be
  87.              computed.  On exit, the contents will have been destroyed.  (For
  88.              a description of the contents of B on exit, see "Further
  89.              Details", below.)
  90.  
  91.      LDB     (input) INTEGER
  92.              The leading dimension of B.  LDB >= max(1,N).
  93.  
  94.      ALPHAR  (output) DOUBLE PRECISION array, dimension (N)
  95.              ALPHAI  (output) DOUBLE PRECISION array, dimension (N) BETA
  96.              (output) DOUBLE PRECISION array, dimension (N) On exit,
  97.              (ALPHAR(j) + ALPHAI(j)*i)/BETA(j), j=1,...,N, will be the
  98.              generalized eigenvalues.  If ALPHAI(j) is zero, then the j-th
  99.              eigenvalue is real; if positive, then the j-th and (j+1)-st
  100.              eigenvalues are a complex conjugate pair, with ALPHAI(j+1)
  101.              negative.
  102.  
  103.              Note: the quotients ALPHAR(j)/BETA(j) and ALPHAI(j)/BETA(j) may
  104.              easily over- or underflow, and BETA(j) may even be zero.  Thus,
  105.              the user should avoid naively computing the ratio alpha/beta.
  106.              However, ALPHAR and ALPHAI will be always less than and usually
  107.              comparable with norm(A) in magnitude, and BETA always less than
  108.              and usually comparable with norm(B).
  109.  
  110.      VL      (output) DOUBLE PRECISION array, dimension (LDVL,N)
  111.              If JOBVL = 'V', the left generalized eigenvectors.  (See
  112.              "Purpose", above.)  Real eigenvectors take one column, complex
  113.              take two columns, the first for the real part and the second for
  114.              the imaginary part.  Complex eigenvectors correspond to an
  115.              eigenvalue with positive imaginary part.  Each eigenvector will
  116.              be scaled so the largest component will have abs(real part) +
  117.              abs(imag. part) = 1, *except* that for eigenvalues with
  118.              alpha=beta=0, a zero vector will be returned as the corresponding
  119.              eigenvector.  Not referenced if JOBVL = 'N'.
  120.  
  121.      LDVL    (input) INTEGER
  122.              The leading dimension of the matrix VL. LDVL >= 1, and if JOBVL =
  123.              'V', LDVL >= N.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      VR      (output) DOUBLE PRECISION array, dimension (LDVR,N)
  141.              If JOBVL = 'V', the right generalized eigenvectors.  (See
  142.              "Purpose", above.)  Real eigenvectors take one column, complex
  143.              take two columns, the first for the real part and the second for
  144.              the imaginary part.  Complex eigenvectors correspond to an
  145.              eigenvalue with positive imaginary part.  Each eigenvector will
  146.              be scaled so the largest component will have abs(real part) +
  147.              abs(imag. part) = 1, *except* that for eigenvalues with
  148.              alpha=beta=0, a zero vector will be returned as the corresponding
  149.              eigenvector.  Not referenced if JOBVR = 'N'.
  150.  
  151.      LDVR    (input) INTEGER
  152.              The leading dimension of the matrix VR. LDVR >= 1, and if JOBVR =
  153.              'V', LDVR >= N.
  154.  
  155.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  156.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  157.  
  158.      LWORK   (input) INTEGER
  159.              The dimension of the array WORK.  LWORK >= max(1,8*N).  For good
  160.              performance, LWORK must generally be larger.  To compute the
  161.              optimal value of LWORK, call ILAENV to get blocksizes (for
  162.              DGEQRF, DORMQR, and DORGQR.)  Then compute:  NB  -- MAX of the
  163.              blocksizes for DGEQRF, DORMQR, and DORGQR; The optimal LWORK is:
  164.              2*N + MAX( 6*N, N*(NB+1) ).
  165.  
  166.      INFO    (output) INTEGER
  167.              = 0:  successful exit
  168.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  169.              = 1,...,N:  The QZ iteration failed.  No eigenvectors have been
  170.              calculated, but ALPHAR(j), ALPHAI(j), and BETA(j) should be
  171.              correct for j=INFO+1,...,N.  > N:  errors that usually indicate
  172.              LAPACK problems:
  173.              =N+1: error return from DGGBAL
  174.              =N+2: error return from DGEQRF
  175.              =N+3: error return from DORMQR
  176.              =N+4: error return from DORGQR
  177.              =N+5: error return from DGGHRD
  178.              =N+6: error return from DHGEQZ (other than failed iteration)
  179.              =N+7: error return from DTGEVC
  180.              =N+8: error return from DGGBAK (computing VL)
  181.              =N+9: error return from DGGBAK (computing VR)
  182.              =N+10: error return from DLASCL (various calls)
  183.  
  184. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  185.      Balancing
  186.      ---------
  187.  
  188.      This driver calls DGGBAL to both permute and scale rows and columns of A
  189.      and B.  The permutations PL and PR are chosen so that PL*A*PR and PL*B*R
  190.      will be upper triangular except for the diagonal blocks A(i:j,i:j) and
  191.      B(i:j,i:j), with i and j as close together as possible.  The diagonal
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))                                                            DDDDGGGGEEEEGGGGVVVV((((3333FFFF))))
  203.  
  204.  
  205.  
  206.      scaling matrices DL and DR are chosen so that the pair  DL*PL*A*PR*DR,
  207.      DL*PL*B*PR*DR have elements close to one (except for the elements that
  208.      start out zero.)
  209.  
  210.      After the eigenvalues and eigenvectors of the balanced matrices have been
  211.      computed, DGGBAK transforms the eigenvectors back to what they would have
  212.      been (in perfect arithmetic) if they had not been balanced.
  213.  
  214.      Contents of A and B on Exit
  215.      -------- -- - --- - -- ----
  216.  
  217.      If any eigenvectors are computed (either JOBVL='V' or JOBVR='V' or both),
  218.      then on exit the arrays A and B will contain the real Schur form[*] of
  219.      the "balanced" versions of A and B.  If no eigenvectors are computed,
  220.      then only the diagonal blocks will be correct.
  221.  
  222.      [*] See DHGEQZ, DGEGS, or read the book "Matrix Computations",
  223.          by Golub & van Loan, pub. by Johns Hopkins U. Press.
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.